Updated documentation for the new validation model and restructured internals by iNinja · Pull Request #3056 · AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet

iNinja · 2024-12-10T15:53:12Z

Updated documentation for the new validation model and restructured internals

Clean up work and documentation updates for the new validation model.

Removed static stack frames and replaced with the simplified approach of GetCurrentStackFrame() and AddCurrentStackFrame()
Updated IssuerValidationSource to be extensible.
Extracted validated fields onto their own files and made the structures read-only.
Updated documentation

Part of #2711

… of GetCurrentStackFrame() and AddCurrentStackFrame()

…fields onto their own files and made the structures read-only.

src/Microsoft.IdentityModel.Tokens/Validation/Validators.IssuerSigningKey.cs

…g IList values from two-part constructors.

… no ActorValidationParameters are provided.

…once the classes/structures are made public.

(cherry picked from commit 07a105f)

…il the ILogger compliance can be resolved. (cherry picked from commit af561ef)

Copilot

Copilot reviewed 28 out of 43 changed files in this pull request and generated no comments.

Files not reviewed (15)

src/Microsoft.IdentityModel.Tokens/InternalAPI.Unshipped.txt: Language not supported
src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.StackFrames.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Saml2SecurityTokenHandler.ValidateToken.StackFrames.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml/SamlSecurityTokenHandler.ValidateToken.StackFrames.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Saml2SecurityTokenHandler.ValidateToken.Internal.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/IssuerSigningKeyValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AudienceValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml/SamlSecurityTokenHandler.ValidateToken.Internal.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JwtTokenUtilities.cs: Evaluated as low risk
src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/MessageDetail.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JwtTokenUtilities.DecryptTokenResult.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.DecryptToken.cs: Evaluated as low risk
src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ReadToken.cs: Evaluated as low risk

jmprieur

LGTM
I've asked a few questions, which I'd like to be addressed, and proposed to improve the error messages to make them more actionable.

src/Microsoft.IdentityModel.Tokens.Saml/Saml/Exceptions/SamlValidationError.cs

src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AlgorithmValidationError.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/Details/AudienceValidationError.cs

...Microsoft.IdentityModel.Tokens/Validation/Results/Details/IssuerSigningKeyValidationError.cs

src/Microsoft.IdentityModel.Tokens/Validation/Results/ValidatedToken.cs

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.DecryptToken.cs

…idation model feature branch.

github-actions · 2025-01-13T15:06:40Z

Summary


Generated on:	1/13/2025 - 3:06:39 PM
Coverage date:	1/13/2025 - 2:57:01 PM - 1/13/2025 - 3:06:14 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

github-actions · 2025-01-13T15:20:30Z

Summary


Generated on:	1/13/2025 - 3:20:29 PM
Coverage date:	1/13/2025 - 3:10:04 PM - 1/13/2025 - 3:19:57 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

…onError

github-actions · 2025-01-13T15:33:57Z

Summary


Generated on:	1/13/2025 - 3:33:56 PM
Coverage date:	1/13/2025 - 3:23:57 PM - 1/13/2025 - 3:33:30 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

github-actions · 2025-01-13T16:12:22Z

Summary


Generated on:	1/13/2025 - 4:12:21 PM
Coverage date:	1/13/2025 - 4:02:50 PM - 1/13/2025 - 4:11:56 PM
Parser:	MultiReport (60x Cobertura)
Assemblies:	1
Classes:	7
Files:	2
Line coverage:	80.3% (620 of 772)
Covered lines:	620
Uncovered lines:	152
Coverable lines:	772
Total lines:	483
Branch coverage:	67.8% (228 of 336)
Covered branches:	228
Total branches:	336
Method coverage:	Feature is only available for sponsors

Coverage

Microsoft.IdentityModel.JsonWebTokens - 80.3%

Name	Line	Branch
Microsoft.IdentityModel.JsonWebTokens	80.3%	67.8%
Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities	100%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated	80.3%	67.8%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F12A1AEDDDFE32BA DF4DBFF323AF1BCB48B9F9721B7CD3E05F5E034CF225E3DF8__CreateJwsRegex_0	81.4%	67.6%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJweRegex_1	79.2%	68%
System.Text.RegularExpressions.Generated.<RegexGenerator_g>F334844C618E00D3 CEC5D3FE0D00CF0141BBEE98635313BB2CB8D3921464CE05A__CreateJwsRegex_0	81.4%	67.6%

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs

src/Microsoft.IdentityModel.Tokens.Saml/Saml/Exceptions/SamlValidationError.cs

src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs

iNinja added 3 commits December 10, 2024 15:40

Removed static stack frames and replaced with the simplified approach…

a664f72

… of GetCurrentStackFrame() and AddCurrentStackFrame()

Updated IssuerValidationSource to be extensible. Extracted validated …

9b66954

…fields onto their own files and made the structures read-only.

Updated documentation

073aae5

iNinja requested a review from a team as a code owner December 10, 2024 15:53

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

143daa7

kllysng reviewed Dec 10, 2024

View reviewed changes

src/Microsoft.IdentityModel.Tokens/Validation/Validators.IssuerSigningKey.cs Show resolved Hide resolved

iNinja added 3 commits December 16, 2024 14:49

Added nullability annotations to ValidationParameters. Enabled settin…

206c0be

…g IList values from two-part constructors.

Handle case where ValidateActor is true, there is an actor token, but…

aa94abc

… no ActorValidationParameters are provided.

Updated documentation, added missing interfaces and methods required …

9e2746c

…once the classes/structures are made public.

iNinja mentioned this pull request Dec 16, 2024

New validation model - Public API review #3060

Closed

iNinja added 4 commits December 16, 2024 17:00

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

0ba56b4

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

42a41bc

Added missing documentation around validation errors

54063b3

(cherry picked from commit 07a105f)

Added CLSCompliant flag to Log methods to address the build issue unt…

5ac80f6

…il the ILogger compliance can be resolved. (cherry picked from commit af561ef)

pmaytak requested a review from Copilot December 20, 2024 21:50

Copilot AI reviewed Dec 20, 2024

View reviewed changes

jmprieur approved these changes Jan 5, 2025

View reviewed changes

iNinja added 3 commits January 13, 2025 13:55

Moved signature error back to internal after merging from the new val…

fa12679

…idation model feature branch.

Cache exceptions from ValidationErrors

b402f51

Merge branch 'dev' into iinglese/tidy-up-new-validation-model

9a3e03a

Added log level checks for log methods in ValidatedToken and Validati…

3403ac5

…onError

Updated comment for issuer validation source for clarity

08acf78

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs Outdated Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.JsonWebTokens/JsonWebTokenHandler.ValidateToken.Internal.cs Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens.Saml/Saml/Exceptions/SamlValidationError.cs Show resolved Hide resolved

brentschmaltz reviewed Jan 13, 2025

View reviewed changes

src/Microsoft.IdentityModel.Tokens.Saml/Saml2/Exceptions/Saml2ValidationError.cs Show resolved Hide resolved

dependabot bot mentioned this pull request Mar 2, 2026

Bump System.IdentityModel.Tokens.Jwt from 6.25.1 to 8.16.0 openwallet-foundation-labs/wallet-framework-dotnet#522

Open

This was referenced Mar 9, 2026

nuget: Bump Microsoft.IdentityModel.Tokens and System.IdentityModel.Tokens.Jwt Lucas3995/LastTechTest#49

Open

chore(deps): Bump the nuget-version-updates group with 2 updates zitadel/example-auth-dotnet#5

Open

Conversation

iNinja commented Dec 10, 2024

Updated documentation for the new validation model and restructured internals

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

jmprieur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 13, 2025

Summary

Coverage

Uh oh!

github-actions bot commented Jan 13, 2025

Summary

Coverage

Uh oh!

github-actions bot commented Jan 13, 2025

Summary

Coverage

Uh oh!

github-actions bot commented Jan 13, 2025

Summary

Coverage

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants